Organizations service for the Moderne platform

This repository template is a service that can be run by Moderne customers to inform the platform about the organizational structure of their repositories. In the reference implementation provided here, the repositories and their organization hierarchy are determined by a hardcoded CSV file plus an "ALL" organization that contains all repositories. This is meant to be customized per organization.

The GraphQL schema for this service is defined in moderne-organizations.graphqls, and serves as the contract for what Moderne expects a customized organization service to provide.

If there is no organization service configured for your agent, Moderne will fall back on a single organization named "ALL". This is convenient for onboarding initially, but as a customer grows and brings more teams onto the platform, they should supply organizational hierarchy to help developers action only their assets.

Getting started

1. Either fork this repository or create a new repository using this as a template.
2. Clone the repository locally.
3. Run ./gradlew bootRun to start the service locally.
4. Go to http://localhost:8080/graphiql to explore the GraphQL API.
5. Run the following GraphQL command to test the service:

query testOrgService {
  organizationsPages {
      edges {
          node {
              ...Org       
          }
      }
  }
  userOrganizationsPages(user: {email: "example@foo.com"}) {
      edges {
          node {
              ...Org
              parent {
                  ...Org
              }
          }
      }
  }
}

fragment Org on Organization {
  id
  name
  commitOptions
}

Customizing the service

You are free to customize the implementation in any way as long as the API contract is implemented correctly.

Creating repos.csv

Use repo-fetchers to generate a (partial) repos.csv and add your organization structure.

The org structure is represented in a series of columns org1..orgN where N is the deepest organization structure. Not every repository needs to have the same depth of organizational structure. To make the resultant CSV renderable in GitHub, you can right-align org structure to orgN as shown in the image below:

There is repetition in organizational hierarchy in this format. The reference implementation validates the internal consistency of those organizational repositories across CSV lines.

You can either overwrite the existing repos.csv, set the moderne.reposCsvPath in application.yaml, or provide the path via an argument on application startup.

If you have multiple organizations with the same display name, you can map id to display name in an id-mapping.txt. A simple reference file is included in this repository.

Mapping repositories

Edit application.yaml and list all the base uris for any private SCM providers used in the repos.csv.

You will need to provide the base URL, type and any alternative URL that can be used to access the same SCM server.

Example:

moderne:
  scm:
    repositories:
      - baseUrl: https://bitbucket.example.com/stash
        type: Bitbucket
        alternativeUrls:
          - http://bitbucket.example.com:8080/stash
          - ssh://bitbucket.example.com/stash
          - ssh://bitbucket.example.com:7999/stash

Make sure to provide the service type. The following (self-hosted) SCM providers are supported: [GitHub,GitLab,Bitbucket].

We use this configuration to split the clone URL into an origin and path.

Note that for an on-premise Bitbucket (DC/server) we should not have the scm/ path segment in the origin or the path. This will automatically be stripped off if you configure this as explained above.

Example: If you have a repository at cloneUrl=https://bitbucket.example.com/stash/scm/openrewrite/rewrite.git and supply https://bitbucket.example.com/stash as the origin it will create a repository:

{
    "origin": "bitbucket.example.com/stash",
    "path": "openrewrite/rewrite",
    "branch": "main"
}

you can set moderne.scm.allow-missing-scm-origins in application.yaml to true if you want to strictly check on startup that all origins in repos.csv are present.

Note: for backwards compatibility we read the origin if the baseUrl is not supplied and apply the default https:// protocol to it. It is highly recommended to update the configuration to contain full URIs.

Commit options

The commitOptions field on the Organization type is a list of strings that represent the commit options that are available to developers in that organization. These are the options that are presented to developers when they create a commit through the Moderne platform. The options are defined in the CommitOption enum in moderne-organizations.graphqls.

CommitOption explained

Name	Description
Direct	The commit will be pushed directly to the repository.
Branch	The commit will be pushed to a branch.
Fork	The commit will be pushed to a fork of the repository.
PullRequest	The commit will be pushed to a pull request.
ForkAndPullRequest	The commit will be pushed to a fork of the repository and a pull request will be opened.

Organization hierarchy

The parent field on the Organization type is a reference to the parent organization. This is how you define the hierarchy of organizations in your company. The root organization should have a null parent.