dovetailsoftware / dovetail-bootstrap Goto Github PK

Get started writing Dovetail SDK applications. Included is an example of a web application using FubuMVC and Windows service application using Topshelf.

Home Page: http://www.dovetailsoftware.com/blogs/kmiller/archive/2012/01/24/introducing-dovetail-bootstrap

License: Other

Ruby 0.71% C# 85.33% JavaScript 4.35% CSS 8.13% HTML 1.48% Batchfile 0.01%

dovetail-bootstrap's People

Contributors

Stargazers

Watchers

Forkers

kevm skopp lovethisgame modulexcite harrinry

dovetail-bootstrap's Issues

Get FubuMVC.Swagger upgraded to use FubuMVC 2

Extract original message email delimiters out of code and into config

add a feature-enabled check for properties and collections in model map

If a feature is disabled, then don't add the property/collection to the model.

For example, if Solution Comments are disabled, don't add the comments collection or the average rating properties to the show solution model.

Attachment upload and download

Attachments are a PITA in Clarify. We need a standard endpoint that accepts attachment uploads.

The web end point should take a file upload and an object to which it should be attached.

The backend storage of this attachment should be modular and default the to the standard Clarify mechanism of storing it to a file path written to the doc_path record.

Alternative backends that store attachments "in the cloud" would be fantastic
@huboard:{"order":6.0,"milestone_order":8,"custom_state":""}

Migrate nuget usage from Ripple to Paket

Paket works well as a replacement for Ripple. I've been using it for sometime both at work and on TikaOnDotnet.

Might be a good time to migrate away from Rakefile as well. 🐰

history parser unicode_non_breaking_alone_not_considered_a_line failing

recent parsing changes broke an edge case

Swagger docs integration

One of the primary goals of Bootstrap is to be a web services platform for Clarify instances. Swagger has very nice auto documentation and client proxy support for Rest-ty APIs.

The goal is to add a Swagger fubu policy which interrogates the BehaviorGraph for IAPI endpoints and emits the correct Swagger-spec output.
@huboard:{"order":12.0}

Automate nuget publishing

document
automate
setApiKey for internal nuget publishing

ModelMap could live in bootstrap

stack overflow if connection string is incorrect

if database connectivity cannot be made (such as a bad password in DovetailDatabaseSettings.ConnectionString), then a stack overflow exception occurs
@huboard:{"order":12.0}

When the accept header is not set for API endpoints we get JSON

We would rather then default be HTML if a view is present.

History view should have custom master layout

People consuming non-partial (XHR) istory html views will likely want the to customize the look and feel of the page.

History - Optionally intermix subcase history with case history

Clarify client mixes subcase history with case history.

Making history heterogeneous could add a bit of complexity. How does the view provide links to the child elements? We would need a a way of identifying the source object of each history element.

History.Parser.HistoryItemParser.ParseEmailLog times out on a HUGE email

likely the regex is timing out.
when we've run into issues like this before, we've executed the regex on its own thread with a timeout, so we can trap for it and handle it.

this seems like a very unrealistic test

2017-11-13 18:59:05,923 [13] ERROR Agent.Core.Configuration.UnhandledExceptionLoggingBehavior - (null) A route /agent/core/history?Id=1002813&Type=case&IsVerbose=false&_=1510627020603 caused an exception that was not handled. 
System.Threading.ThreadAbortException: Thread was being aborted.
   at Dovetail.SDK.Bootstrap.History.Parser.HistoryItemParser.ParseEmailLog(String input)
   at Dovetail.SDK.Bootstrap.History.Parser.HistoryOutputParser.EncodeEmailLog(String input)
   at Dovetail.SDK.Bootstrap.History.CommonActEntryBuilderDSLExtensions.EncodeEmail(IHistoryOutputParser historyOutputParser, HistoryItem item)
   at Dovetail.SDK.Bootstrap.History.HistoryItemAssembler.createActivityDTOFromMapper(ActEntry actEntry, IDictionary`2 templateRelatedGenerics)
   at System.Linq.Enumerable.WhereSelectListIterator`2.MoveNext()
   at System.Linq.Enumerable.WhereEnumerableIterator`1.MoveNext()
   at System.Collections.Generic.List`1..ctor(IEnumerable`1 collection)
   at System.Linq.Enumerable.ToList[TSource](IEnumerable`1 source)
   at Dovetail.SDK.Bootstrap.History.HistoryItemAssembler.Assemble(ClarifyGeneric actEntryGeneric, IDictionary`2 templatesByCode, HistoryRequest historyRequest)
   at Dovetail.SDK.Bootstrap.History.HistoryBuilder.Build(HistoryRequest request, Action`2 genericAction)
   at Dovetail.SDK.Bootstrap.History.AssemblerPolicies.CaseHistoryAssemblerPolicy.BuildHistory(HistoryRequest request)
   at Dovetail.SDK.Bootstrap.History.HistoryAssembler.GetHistory(HistoryRequest request)
   at FubuMVC.Core.Behaviors.OneInOneOutActionInvoker`3.performInvoke()
   at FubuMVC.Core.Behaviors.BasicBehavior.Invoke()
   at FubuMVC.Core.Continuations.ContinuationHandler.InvokeNextBehavior()
   at FubuMVC.Core.Continuations.ContinuationHandler.performInvoke()
   at FubuMVC.Core.Behaviors.BasicBehavior.Invoke()
   at FubuMVC.Core.Behaviors.BasicBehavior.<.ctor>b__0()
   at FubuMVC.Core.Behaviors.BasicBehavior.Invoke()
   at FubuMVC.Core.Behaviors.BasicBehavior.<.ctor>b__0()
   at FubuMVC.Core.Behaviors.BasicBehavior.Invoke()
   at Agent.Core.Configuration.UnhandledExceptionLoggingBehavior.wrapBehaviorInLogger(Action action)
2017-11-13 19:00:05,549 [18] WARN  Dovetail.SDK.Bootstrap.History.Parser.HistoryItemParser - (null) Could not parse email log. Contents:

Custom Errors support

Wrap API calls with pretty error support so users do not see YSOD when exceptions are thrown.

@huboard:{"order":11.5}

Create Case

Contact, Site, Title, Description

and...

Case Type
Priority
Severity
Queue

Divine default timezone for a user based on their site

Currently authtoken users do not have their timezone set. This will affect the time stamps on results returned e.g. history.

Move history support into a bottle

Dovetail.Bootstrap contains a few things like History that could be factored out into their own Nuget.

integration tests probably wont work for customers

The integration tests probably wont work for customers.

The tests reference data that they probably don't have, such as:
const string level1Title = "Marketing Information";
const string listTitle = "CR_DESC";
const string level1Title = "PC";
const string level2Title = "Windows 3.1";
etc.

should we add some more details about running the integration tests in teh readme?
such as, if you're a customer - don't run them?

lets discuss.

Potential caching issue with variables over time

Observed in Focus:

2017-11-22 09:59:41,787 [22] ERROR Agent.Core.Configuration.UnhandledExceptionLoggingBehavior - (null) A route /agent/support/cases/16207?_=1511366386982 caused an exception that was not handled. 
System.NullReferenceException: Object reference not set to an instance of an object.
   at FChoice.Foundation.FCSession.get_UserName()
   at Dovetail.SDK.ModelMap.SdkUserNameVariable.Expand(VariableExpansionContext context)
   at Dovetail.SDK.ModelMap.Serialization.XElementSerializer.Deserialize[T](XElement element)
   at Dovetail.SDK.ModelMap.Serialization.AddArgument.Visit(XElement element, ModelMap map, ParsingContext context)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.<>c__DisplayClass3.<Visit>b__1(IElementVisitor visitor)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.Visit(XElement element, ModelMap map, ParsingContext context)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.<>c__DisplayClass3.<Visit>b__1(IElementVisitor visitor)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.Visit(XElement element, ModelMap map, ParsingContext context)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.<>c__DisplayClass3.<Visit>b__1(IElementVisitor visitor)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.Visit(XElement element, ModelMap map, ParsingContext context)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.<>c__DisplayClass3.<Visit>b__1(IElementVisitor visitor)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.Visit(XElement element, ModelMap map, ParsingContext context)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.<>c__DisplayClass3.<Visit>b__1(IElementVisitor visitor)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.Visit(XElement element, ModelMap map, ParsingContext context)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.<>c__DisplayClass3.<Visit>b__1(IElementVisitor visitor)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.Visit(XElement element, ModelMap map, ParsingContext context)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.<>c__DisplayClass3.<Visit>b__1(IElementVisitor visitor)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.Visit(XElement element, ModelMap map, ParsingContext context)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.<>c__DisplayClass3.<Visit>b__1(IElementVisitor visitor)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.Visit(XElement element, ModelMap map, ParsingContext context)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.<>c__DisplayClass3.<Visit>b__1(IElementVisitor visitor)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.Visit(XElement element, ModelMap map, ParsingContext context)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.<>c__DisplayClass3.<Visit>b__1(IElementVisitor visitor)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.XElementService.Visit(XElement element, ModelMap map, ParsingContext context)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.Serialization.ModelMapParser.parse(ModelMap map, XDocument document, ModelMapCompilationReport report)
   at Dovetail.SDK.ModelMap.Serialization.ModelMapParser.Parse(ModelMap map, String filePath)
   at Dovetail.SDK.ModelMap.Serialization.Overrides.ModelMapOverrideParser.Parse(ModelMap map, String filePath)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at System.Collections.Generic.GenericEnumerableExtensions.Each[T](IEnumerable`1 values, Action`1 eachAction)
   at Dovetail.SDK.ModelMap.ModelMapCache.findMaps(String include)
   at System.Lazy`1.CreateValue()

This happened with ALL maps.
Caching was disabled at the time.

Bootstrap Console - example of making clarify command line apps

There is lots of awesome Fubu support for command line applications. We have customers that frequently want to write a simple one off command line app to do Dovetail/Clarify thingies.

web app not working - 404 with signin page

app compiles, and the web project starts up, navigates to http://localhost:64935/user/signin?ReturnUrl=%2f, which returns a 404.

Possible bug ModelMap ViaAdHocRelation

Commonwealth ran into a possible bug when ViaAdHocRelation is used under the context of a MapMany.To(). They do not see the ad hoc table being traversed.

I believe this is happening because currently because ad hoc relations are all being created off the root generic.

Dovetail Seeker search client support

Dovetail Seeker client support into its own project so we can nuget-ize it and leverage it in the Bootstrap example web app.
@huboard:{"order":3.0,"milestone_order":11,"custom_state":""}

createcase api is not honoring user

I created a case using the CreateCase API, using a token for a user named "dovetail"
the case was created by the user "sa"
It should have been created as the user "dovetail"

@huboard:{"order":13.0}

authenticationService.SignIn throws an error if a user has an inactive status

if user.status = 0 then SignIn throws an error.

Diagnostics results in a 404 when app is setup as a virtual directory

Created a bootstrap virtual directory.
app works using : http://localhost/bootstrap
click the diagnostics link, which has a URL of: http://localhost/_fubu
this results in a 404 error
url should be http://localhost/bootstrap/_fubu

Pull HGBSTList ElementBuilder support in from another Dovetail product

I built a Fubu Html convention that supports rendering HGBST lists

public class HGBSTDropdownBuilder : ElementTagBuilder {}

Once the javascript and endpoint support are added this will make a good contribution to Bootstrap.

HistoryItemParser logging errors, but I think these should be warnings

Since we're catching and not re-throwing these, should we just log as warnings rather than errors?

        public IEnumerable<IItem> ParseContent(string input)
        {
            try
            {
                return _historyParser.ContentItem.Many().End().Parse(input);
            }
            catch (Exception e)
            {
                _logger.LogError("Could not parse content. Contents:\n\n{0}".ToFormat(input), e);
                return fakeContent(input);
            }
        }

        public EmailLog ParseEmailLog(string input)
        {
            try
            {
                return _historyParser.LogEmail.Parse(input);
            }
            catch (Exception e)
            {
                _logger.LogError("Could not parse email log. Contents:\n\n{0}".ToFormat(input), e);
                return fakeEmailLog(input);
            }
        }

Add CreateSession(string userName, ClarifyLoginType loginType) to IClarifySession interface

Discovered when trying to execute a task set by Carrier for the purpose of https://github.com/DovetailSoftware/carrier/issues/110

The extra method is needed to facilitate creating passwordless User session when Integrated Security=SSPI is used in connection string instead of user id and password.

Move ModelMap into Bootstrap

Cookies for authenticated user whose login names are not valid Clarify users is a PITA

(10101) Could not log in user 'annie', invalid username or password.

This is very much an edge case.

in development when switching databases being used for a given domain (localhost) and if your web browser has a cookie that is valid and authenticated for a users who does not exist on the new database.

The only way to be able to login is to go into developer tools and delete the Agent.auth cookie.

Maybe the web server if it sees a valid cookie for a user that does not exist could tell the browser to delete the cookie.

Logger is too verbose

2012-03-05 15:33:27,177 DEBUG Dovetail.SDK.Bootstrap.ILogger - (null) Whitelisting default extensions: gif, jpg, css, js, png, htm, html

Every request is thrown out this log
@huboard:{"order":11.0}

Publish private Nuget of SDK Bootstrap assembly

Remove references to internal resources

$dovetail-bootstrap\buildsupport\deploy.rb has a reference to
http://focus.dovetailsoftware.com/nuget
which is inaccessible from the outside world.
This causes rake to abort when a customer tries to build the project.

Need to fix this so that customers who try to build aren't blocked due to this.

History config: Add ability to configure what email headers to parse

There is an array of localized StringTokens (headers are localized) used to find email headers in email log history content.

Read me points to 404 link

Hope all is we with y'all.

default rake task, unit tests, talking to database

The default rake task:
rake default # Default, compiles and runs unit tests

is touching the database, creating cases, etc.

this is unexpected.

expected it to just run unit tests, not integration tests.

Move ISystemTime into Bootstrap from ModelMap

Not sure why ModelMap hosts the ISystemTime interface but this would be better placed in Bootstrap. Lovely breaking change.

Session lookup is case-sensitive resulting with multiple sessions per user

Reported in https://support.dovetailsoftware.com/agent/support/cases/24670

Steps to reproduce:

Test 1: Only use lowercase login name.

recycle the app pool for Agent 21
log into Agent 21 three times from different browser windows, using sa as login name.
Go to Admin -> User Sessions: observe Number of User Sessions: 1 and Active Users: sa
Do some "walking around" - view/edit cases, sites, contacts, etc. in all three instances
Go to Admin -> User Sessions: observe Number of User Sessions: 1 and Active Users: sa

Test 2: Use mixed case login name.

recycle the app pool for Agent 21
log into Agent 21 three times from different browser windows but use sa, Sa, and SA as login names.
Go to Admin -> User Sessions: observe Number of User Sessions: 3 and Active Users: sa, Sa, SA
Do some "walking around" - view/edit cases, sites, contacts, etc. in all three instances
Go to Admin -> User Sessions: observe Number of User Sessions: 1 and Active Users: sa, Sa, SA

Test 3: Only use uppercase login name.

recycle the app pool for Agent 21
log into Agent 21 one time using ANNIE as login name.
Do some "walking around" - view/edit cases, sites, contacts, etc.
log into Agent 21 from another browser window using sa as login name.
Go to Admin -> User Sessions: observe Number of User Sessions: 3 and Active Users: sa, annie, ANNIE

The extra sessions are redundant.

Customer claims this leads to performance issues due to locking mechanism utilized in \source\Dovetail.SDK.Bootstrap\Clarify\ClarifySessionCache.cs. With 223 sessions in the cache it is observable by Microsoft Support and reported in https://support.dovetailsoftware.com/agent/support/cases/22928 as a possible locking issue inside log4net leading at first towards upgrading log4net to the latest version but proved to be a dead-end route because log4net is not the problem here.

Proposed solution:

make sure session lookup and creation only uses lowercase login names
use _logger.Push upon successful lock (SyncRoot) instead of prior to it.