integrations / slack Goto Github PK

https://github.com/github-slack/app/blob/df04c7a51df216410d3b94874082c72f16c2fc36/lib/slack/renderer/PullRequest.js#L96-L101

This issue was generated by todo based on a @todo comment in df04c7a. It's been assigned to @wilhelmklopp because they committed the code.

Fired on the pull_request.synchronize event

Estimate: 0.5 weeks

This should be in a thread for x minutes

A user sees an ephemeral prompt to verify that the private link should be unfurled (always, this time, never)

Estimate: 1 week

Depends on #52 (SHOULD)

Unfurls are currently not supported by workspace-based Slack apps. Once they are, we need to update the code that makes use of OLD_MODEL_SLACK_SECRET_TOKEN and OLD_MODEL_SLACK_TEST_TOKEN

e.g. https://github.com/wilhelmklopp

At the moment, all our unfurls are major, but if multiple GitHub links are contained in the same message, they should be minor in order to take up less space.

Relevant Slack docs: https://api.slack.com/docs/message-link-unfurling#slack_app_unfurling

Additionally, don't unfurl at all if more than 3 links are shared in one message

We should send a notification for the deployment event that for example Heroku generates.

Example on branch: #22

Consideration: Only show master deployments?

Estimate: 0.5 weeks

/github unsubscribe [account] [type] to unsubscribe from a specific type of notifications (issues, prs, comments, reviews, etc)

Estimate: 1 week

/github subscribe owner/repo to subscribe to notifications for a repository

Estimate: 1 week

A user sees related changes that happen quickly (1 min) after the initial event as edits to the original message (statuses, more pushes, etc).

Demo: https://www.youtube.com/watch?v=dSucU5cny5Q

Estimate: 1 week

/github subscribe owner to subscribe to notifications for an account

Estimate: 0.5 weeks

Likely postgres

Simple app that lets you select scopes and then kicks off the Slack OAuth flow so that you can see how dangerous your selected scopes are:

Prototype: https://slack.com/oauth/authorize?&client_id=228003400966.234593166005&scope=admin,commands,incoming-webhook,channels:history,channels:read,channels:write,chat:write:bot,chat:write:user,dnd:read,dnd:write,emoji:read,files:read,files:write:user,groups:history,groups:read,groups:write,im:history,im:read,im:write,links:read,links:write,mpim:history,mpim:read,mpim:write,pins:read,pins:write,reactions:read,reactions:write,reminders:read,reminders:write,search:read,stars:read,stars:write,team:read,usergroups:read,usergroups:write,users.profile:read,users.profile:write,users:read,users:read.email,users:write

A user is notified of GitHub status changes from status.github.com

Estimate: 1.5 weeks

• Create GitHub app: https://github.com/organizations/github-slack/settings/apps/slack-next/advanced
• Create Slack app: https://api.slack.com/apps/A6Y4MULQ6
• Create Heroku app: https://dashboard.heroku.com/apps/github-slack-app
• deploy and wire everything together
• Setup auto deploy on heroku
• Set beautiful icons for all the things

cc @wilhelmklopp

Estimate: 0.5 weeks

Link to file:
https://github.com/github-slack/app/blob/bc0332b20cbbfe8bd1f6eda9b44ab008588cbb52/index.js

Link to specific lines:

https://github.com/github-slack/app/blob/bc0332b20cbbfe8bd1f6eda9b44ab008588cbb52/index.js#L51-L52

Only unfurl a link once per x hours per channel

Estimate: 1 week

https://github.com/github-slack/app/blob/3c3a1e2694fec8ee247293bddd3a26029d567484/lib/slack/renderer/index.js#L332-L337

This issue was generated by todo based on a @todo comment in 3c3a1e2 in #40. It's been assigned to @wilhelmklopp because they committed the code.

🤖
🤖
🤖 🤖
🤖
🤖
🤖
🤖
🤖
🤖
🤖
🤖 🤖
🤖
🤖 🤖
🤖
🤖
🤖
🤖
🤖
🤖
🤖
🤖 🤖
🤖
🤖 🤖
🤖
🤖
🤖
🤖
🤖
🤖
🤖
🤖 🤖
🤖
🤖 🤖
🤖
🤖
🤖
🤖
🤖
🤖
🤖
🤖 🤖
🤖
🤖 🤖
🤖
🤖
🤖
🤖
🤖
🤖
🤖
🤖

Estimate: 1 week

with body truncated

e.g. http://github.com/probot/probot

Estimate: 0.5 weeks

In the interest of resiliency and scalability, the app should store any incoming events in a queue, and run background workers to work the jobs off the queue.

Estimate: 1 week

e.g. https://github.com/github

Estimate: 0.5 weeks

A lot of the different functions in issues.js do the same thing and can be combined now that we have the renderer in place.

e.g. https://github.com/github

Estimate: 0.5 weeks

When generating new snapshots for the first time (and potentially in other cases), it would be useful to see an image of the rendered slack message, in addition to the JSON object.

Example Jest output at the moment:

● Pull request rendering › works for minor notifications

    expect(value).toMatchSnapshot()

    New snapshot was not written. The update flag must be explicitly passed to write a new snapshot.

    This is likely because this test is run in a continuous integration (CI) environment in which snapshots are not written by default.

    Received value
    Object {
      "attachments": Array [
        Object {
          "author_icon": "https://avatars0.githubusercontent.com/u/173?v=4",
          "author_link": "https://github.com/bkeepers",
          "author_name": "bkeepers",
          "color": "#6f42c1",
          "fallback": "#36 Rearrange logic",
          "footer": "<https://github.com/github-slack/app/pull/36|View it on GitHub>",
          "footer_icon": "https://assets-cdn.github.com/favicon.ico",
          "mrkdwn_in": Array [
            "text",
          ],
          "title": "#36 Rearrange logic",
          "title_link": "https://github.com/github-slack/app/pull/36",
          "ts": 1506619320,
        },
      ],
    }


      at Object.test (test/renderer/index.test.js:91:22)
          at Promise (<anonymous>)
          at <anonymous>
      at process._tickCallback (internal/process/next_tick.js:188:7)

 › 1 snapshot test failed.

If we build this, the Jest output above would remain, but additionally a screenshot would be shown:

We would do this by passing in the Jest snapshot to the Slack Message Builder and then take a screenshot of the rendered message with Puppeteer. We can display the image in the terminal using something like imagemagick

@bkeepers

re style guide and the snapshot tests, it’d be cool if the app actually had rendered examples of all them message types. So if you go to /styleguide/examples you could see all the messages in one view

https://github.com/github-slack/app/blob/a8cfa539aee3f9b20dd905027d4206cdf9118b8d/lib/slack/renderer/deployment-status.js#L7-L12

This issue was generated by todo based on a @todo comment in a8cfa53. It's been assigned to @wilhelmklopp because they committed the code.

https://github.com/github-slack/app/blob/8179b7fd369a7d3c39c16ab3d1ad4b5534b2d968/lib/github/notifications/deployments.js#L6-L11

This issue was generated by todo based on a @todo comment in 8179b7f. It's been assigned to @wilhelmklopp because they committed the code.

Since this is a private repo we cannot use Travis on the free plan.
We need to figure out a way to upgrade :)

Edit: Also something like greenkeeper/dependabot would be neat. I had a problem just now and either of those would have saved me 10-20min of investigating 😬

If I write this test:

require('../lib/storage');

test('hello', () => {
  console.log("done");
});

And run jest test/repro.test.js then I get this output:

 PASS  test/repo.test.js
  ✓ hello (4ms)

  console.log test/repo.test.js:4
    done

Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        0.234s, estimated 1s
Ran all test suites matching /test\/repo.test.js/i.

But the process hangs and you have to type ctrl+c to kill it.

Only unfurl a link once per x hours per channel

Estimate: 1 week

Need to create end to end tests for all GitHub events we're listening to

We should set up Sentry or a similar tool so that we can monitor errors that happen in the production environment. We currently don't see those.

https://github.com/github-slack/app/blob/a8cfa539aee3f9b20dd905027d4206cdf9118b8d/lib/slack/renderer/deployment-status.js#L6-L11

This issue was generated by todo based on a @todo comment in a8cfa53. It's been assigned to @wilhelmklopp because they committed the code.

As a further iteration on #8, it should also unfurl links to rendered documents, like https://github.com/github-slack/app/blob/master/README.md

Estimate: 2 weeks

This issue was closed by @wilhelmklopp, but the renderer showed it as @bkeepers

I'm going through this now as I work on getting an instance of this deployed.

• Relevant bits from https://probot.github.io/docs/deployment/
  • Permissions:
    • Issues (read) with issues webhook
    • Pull Requests (read) with pull_request webhook
• Creating a Slack app

Estimate: 0.5 weeks

https://github.com/github-slack/app/blob/148de45a6cce0c30c5d2825290f9748d5c60b68d/lib/renderer/index.js#L332-L337

This issue was generated by todo based on a @todo comment in 148de45 in #40. It's been assigned to @wilhelmklopp because they committed the code.

A user sees an ephemeral prompt to verify that the private link should be unfurled (always, this time, never)
A user sees an unfurl of a private link.

Estimate: 2 weeks

Private unfurls are available via EARLY ACCESS

Read through this comment to find out how to get early access: #52 (comment)

Road to private unfurls

Things that need to be done before general availability:

• Persistent user settings #528
• Better flow in case a user has not yet linked their GitHub account (building on top of #536)
• Let users change settings using /github settings
• dm user if chat.ephemeral doesn't work because app is not in channel
  • Can we prompt users via additive permissions to add GitHub to the channel? Nope, not really :/
• Remove early access for private unfurls 🎉

We've talked a few times about looking into TypeScript. Before we get too far on this project, we should evaluate if that is something we want to do.

Estimate: 1 week

e.g. https://github.com/octokit/octokit.rb

This is pretty intense (especially for apps that have a lot of statuses).

Proposal:

• Collapse success statuses into one attachment, similar to how the GitHub UI does it, maybe with a link to this:
  
• If there are only 2-3 failing statuses, show details of the failure separately
• Otherwise, just show summary like "5 of 11 checks failed" with link to GitHub UI showing failures.

It would be awesome if our production environment allowed us to make new features available first to all GitHub staff, and then to some small subset of all users (like canary for github/github)

cc @bkeepers for 💬 on whether we should do this and how we would accomplish it

/github unsubscribe owner/repo to unsubscribe to notifications for a repository

Estimate: 0.5 weeks

We intend to use Slack's new workspace-based app model. Our launch timeline will be dictated by Slack's timeline for making them distributable.

Slack's message formatting is not quite markdown. We should do our best to translate GitHub markdown into something that displays decently on Slack.

Estimate: 2 weeks

This allows us to negate the [owner/repo] prefix in the pretext of many messages.

Message Builder Example