@backstage/plugin-catalog-backend-module-msgraph 0.4.3-next.2 → 0.4.4-next.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @backstage/plugin-catalog-backend-module-msgraph
 
+## 0.4.4-next.0
+
+### Patch Changes
+
+- 8d1a5e08ca: `MicrosoftGraphOrgEntityProvider`: Add option to configure schedule via `app-config.yaml` instead of in code.
+
+  Please find how to configure the schedule at the config at
+  https://github.com/backstage/backstage/tree/master/plugins/catalog-backend-module-msgraph#readme
+
+- 384f99c276: Add `microsoftGraphOrgEntityProviderCatalogModule` (new backend-plugin-api, alpha).
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.5.1-next.0
+  - @backstage/backend-tasks@0.3.7-next.0
+  - @backstage/catalog-model@1.1.3-next.0
+  - @backstage/backend-plugin-api@0.1.4-next.0
+  - @backstage/plugin-catalog-node@1.2.1-next.0
+  - @backstage/config@1.0.4-next.0
+
+## 0.4.3
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/catalog-model@1.1.2
+  - @backstage/plugin-catalog-backend@1.5.0
+  - @backstage/backend-tasks@0.3.6
+  - @backstage/config@1.0.3
+
 ## 0.4.3-next.2
 
 ### Patch Changes

package/README.md

@@ -85,6 +85,13 @@ catalog:
           # in order to add extra information to your groups that can be used on your custom groupTransformers
           # See  https://docs.microsoft.com/en-us/graph/api/resources/schemaextension?view=graph-rest-1.0
           select: ['id', 'displayName', 'description']
+        schedule: # optional; same options as in TaskScheduleDefinition
+          # supports cron, ISO duration, "human duration" as used in code
+          frequency: { hours: 1 }
+          # supports ISO duration, "human duration" as used in code
+          timeout: { minutes: 50 }
+          # supports ISO duration, "human duration" as used in code
+          initialDelay: { seconds: 15},
 ```
 
 `user.filter` and `userGroupMember.filter` are mutually exclusive, only one can be provided. If both are provided, an error will be thrown.
@@ -116,13 +123,21 @@ yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-msgraph
 +  builder.addEntityProvider(
 +    MicrosoftGraphOrgEntityProvider.fromConfig(env.config, {
 +      logger: env.logger,
++      scheduler,
++    }),
++  );
+```
+
+Instead of configuring the refresh schedule inside the config (per provider instance),
+you can define it in code (for all of them):
+
+```diff
+-      scheduler,
 +      schedule: env.scheduler.createScheduledTaskRunner({
 +        frequency: { hours: 1 },
 +        timeout: { minutes: 50 },
-+        initialDelay: { seconds: 15}
++        initialDelay: { seconds: 15},
 +      }),
-+    }),
-+  );
 ```
 
 ## Customize the Processor or Entity Provider
@@ -161,10 +176,7 @@ export async function myGroupTransformer(
  builder.addEntityProvider(
    MicrosoftGraphOrgEntityProvider.fromConfig(env.config, {
      logger: env.logger,
-     schedule: env.scheduler.createScheduledTaskRunner({
-       frequency: { minutes: 5 },
-       timeout: { minutes: 3 },
-     }),
+     scheduler,
 +    groupTransformer: myGroupTransformer,
    }),
  );

package/alpha/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@backstage/plugin-catalog-backend-module-msgraph",
+  "version": "0.4.4-next.0",
+  "main": "../dist/index.cjs.js",
+  "types": "../dist/index.alpha.d.ts"
+}

package/config.d.ts

@@ -14,14 +14,10 @@
  * limitations under the License.
  */
 
+import { TaskScheduleDefinitionConfig } from '@backstage/backend-tasks';
+
 export interface Config {
-  /**
-   * Configuration options for the catalog plugin.
-   */
   catalog?: {
-    /**
-     * List of processor-specific options and attributes
-     */
     processors?: {
       /**
        * MicrosoftGraphOrgReaderProcessor configuration
@@ -109,9 +105,7 @@ export interface Config {
         }>;
       };
     };
-    /**
-     * List of provider-specific options and attributes
-     */
+
     providers?: {
       /**
        * MicrosoftGraphOrgEntityProvider configuration.
@@ -209,6 +203,11 @@ export interface Config {
                */
               search?: string;
             };
+
+            /**
+             * (Optional) TaskScheduleDefinition for the refresh.
+             */
+            schedule?: TaskScheduleDefinitionConfig;
           }
         | Record<
             string,
@@ -292,6 +291,11 @@ export interface Config {
                  */
                 search?: string;
               };
+
+              /**
+               * (Optional) TaskScheduleDefinition for the refresh.
+               */
+              schedule?: TaskScheduleDefinitionConfig;
             }
           >;
     };