Merge pull request #5312 from backstage/rugvip/refcount

catalog-plugin/next: add Context

plugins/catalog-backend/src/next/Context/BackgroundContext.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2021 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Context, ContextKey } from './types';
+
+/**
+ * A base Context implementation that does not hold any value.
+ */
+export class BackgroundContext implements Context {
+  getContextValue<T>(key: ContextKey<T>): T {
+    return key.defaultValue;
+  }
+}

plugins/catalog-backend/src/next/Context/ContextWithValue.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2021 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Context, ContextKey } from './types';
+
+/**
+ * A Context implementation that holds a single value, optionally extending an existing context.
+ */
+export class ContextWithValue implements Context {
+  static create(parent: Context, key: ContextKey<unknown>, value: unknown) {
+    return new ContextWithValue(parent, key, value);
+  }
+
+  private constructor(
+    private readonly parent: Context,
+    private readonly key: ContextKey<unknown>,
+    private readonly value: unknown,
+  ) {}
+
+  getContextValue<T>(key: ContextKey<T>): T {
+    if (this.key === key) {
+      return this.value as T;
+    }
+    return this.parent.getContextValue(key);
+  }
+}

plugins/catalog-backend/src/next/Context/TransactionValue.ts

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2021 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Context, ContextKey } from './types';
+import { Knex } from 'knex';
+import { ContextWithValue } from './ContextWithValue';
+
+const transactionContextKey = new ContextKey<Knex.Transaction | undefined>(
+  undefined,
+);
+
+/**
+ * TransactionValue handles the wrapping of a knex transaction in a Context.
+ */
+export class TransactionValue {
+  static in(parent: Context, tx: Knex.Transaction) {
+    return ContextWithValue.create(parent, transactionContextKey, tx);
+  }
+
+  static from(context: Context): Knex.Transaction {
+    const transaction = context.getContextValue(transactionContextKey);
+    if (!transaction) {
+      throw new Error(`No transaction available in context`);
+    }
+    return transaction;
+  }
+}

plugins/catalog-backend/src/next/Context/index.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2021 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { BackgroundContext } from './BackgroundContext';
+export { ContextWithValue } from './ContextWithValue';
+export { TransactionValue } from './TransactionValue';
+export { ContextKey } from './types';
+export type { Context } from './types';

plugins/catalog-backend/src/next/Context/types.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2021 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export class ContextKey<T> {
+  constructor(readonly defaultValue: T) {}
+}
+
+export interface Context {
+  getContextValue<T>(key: ContextKey<T>): T;
+}